home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / keno12.zip / KENO.DOC < prev    next >
Text File  |  1992-12-23  |  21KB  |  464 lines
  1.  
  2.                                 K E N O
  3.  
  4.                                   v1.2
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    The objective of Sunrise KENO is for you to match as many of the numbers the
  21.    computer has picked at random. The computer will pick 20 numbers at random,
  22.    between 1 and 75. You then get a chance to pick your 8 numbers, one at a
  23.    time. All picks must be unique!
  24.  
  25.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  26.          created in the directory you run the door from.
  27.  
  28.  
  29.  
  30.                               INSTALLATION
  31.                               ____________
  32.  
  33.  
  34.    Installation is fairly easy and straight-forward. The following steps and
  35.    examples should have you up and running in a very short period of time.
  36.    It is assumed that you are familiar with setting up DOORS on your system.
  37.    To this end, only examples of the configuration file and Door batch file
  38.    are described.
  39.  
  40.       1) Create a directory to hold all KENO files
  41.  
  42.       2) Unzip KENOxx.ZIP into the the above directory
  43.  
  44.       3) Create a configuration file, with a name of your choice, or
  45.          modify the supplied KENO.CFG file. A description follows:
  46.  
  47.             **                       Location of system file (See Below)
  48.             SUNRISE-80 BBS           Your BBS Name
  49.             Al                       Sysop's First nameAP
  50.  
  51.             Lawrence                 Sysop's Last Name
  52.  
  53. |-----------------------------------------------------------------------------|
  54. | READ!     1                        CommPort  \ These 2 lines are required   |
  55. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  56. |-----------------------------------------------------------------------------|
  57.  
  58.             00000000                 Registration Number
  59.  
  60.         #   2                        Keyboard timeout value in Minutes
  61.  
  62.    !    #   2                        Maximum # of Games per day
  63.                                      (Sysop gets 99 in Registered version)
  64.  
  65.         #   0                        Max # of days a caller can make up, during
  66.                                      calls in one day. 0=Disable Make-up Option
  67.                                      Maximum value = 27, Minimum value = 1
  68.  
  69.         #   N                        Automatic game reset at end of month:
  70.                                        Y = Yes enable autoreset
  71.                                        N = Keep accumulating scores
  72.  
  73.     !   #   0                        Time Allowed in Door
  74.                                      (Sysop = Time Remaining - REG. VERSION)
  75.  
  76.  
  77.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  78.                                      2 = Display ADOPT-A-DOOR message
  79.  
  80.         #   NONE                     Drive:\Path\Filename to contain the
  81.                                      Top Score Bulletin or enter NONE
  82.                                      for NO Bulletin creation.
  83.  
  84.         #   NONE                     Drive:\Path\Filename to contain the
  85.                                      Top Score Bulletin (Color) or enter NONE
  86.                                      for NO Bulletin creation.
  87.  
  88.         #   NONE                     Drive:\Path\Filename to contain the
  89.                                      Hall of Fame Bulletin or enter NONE
  90.                                      for NO Bulletin creation.
  91.  
  92.         #   NONE                     Drive:\Path\Filename to contain the
  93.                                      Hall of Fame Bulletin (Color) or enter NONE
  94.                                      for NO Bulletin creation.
  95.  
  96.         #   Y                        Y = Allow Sysop to have 999 games
  97.                                      N = Do Not Allow Sysop 999 games
  98.  
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.  
  110.     @   #   XXXX/YYYY                 Blackout Range  From/To
  111.     @   #   XXXX/YYYY                 Blackout Range  From/To
  112.     @   #   XXXX/YYYY                 Blackout Range  From/To
  113.     @   #   XXXX/YYYY                 Blackout Range  From/To
  114.     @   #   XXXX/YYYY                 Blackout Range  From/To
  115.  
  116.           ** = Replace with ONE of the following:
  117.  
  118. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  119. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  120. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  121.                                    (Note:DOOR.SYS must be in SAME directory)
  122. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  123. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  124. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  125. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  126. C:\BBS\CHAIN.TXT                <- For WWIV systems
  127. C:\BBS\GTUSER.BBS               <- For GT Power
  128.                                    * if using this option you must put the
  129.                                      ComPort # on line 5 and the Node # on
  130.                                      line 6 of the configuration file
  131.  
  132.  
  133.            # = Requires registration to change to a different value.
  134.            ! = See "Plays Per Day/Door Time" Below
  135.            @ = See "Blackout Periods" Below
  136.  
  137.                NOTE: There are NO Blank Lines in the Config File!!
  138.  
  139.  
  140.       4) Create a batch file or modify the DOMINOES file supplied. A
  141.          description of this file follows:
  142.  
  143.             ECHO off
  144.             cd\BBS\DOORS\KENO         Location of KENO files
  145.             KENO KENO.CFG             EXE filename and CFG filename (Name
  146.                                       used in creating file in #3 above)
  147.             CD\BBS
  148.             BOARD
  149.  
  150.  
  151.        5) When running in more than one node, be sure to supply a
  152.           different configuration name for each node (or see below).
  153.  
  154.        6) If running with a Fossil-based multi-port board add
  155.            /FD to the line containing the CFG name as follows:
  156.  
  157.                           KENO KENO.CFG /FD
  158.  
  159.  
  160.                MAKE-UP DAYS (Registered version only)
  161.                --------------------------------------
  162.  
  163. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  164. during the current month and prior to the current call. You control whether
  165. to allow this option, as well as the number of days the caller can make up, on
  166. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  167. configuration file, turns the option OFF, any other value (up to a max of 27)
  168. turns the option ON and dictates the number of days the caller can make up.
  169.  
  170.  
  171. NOTE:      The number of games per day is calculated as follows...
  172.  
  173.            Games Allowed per day x Number of makeup days.
  174.  
  175. Example:   Games Allowed per day = 2
  176.            Max # of makeup days  = 4
  177.  
  178. If a caller logs in on 5/8/92 and this is their first call of the month, they
  179. would have a potential of 16 games to makeup and bring them current
  180. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  181. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  182. (games allowed * max # of makeup days).
  183.  
  184.  
  185.  
  186.              HALL OF FAME BULLETINS (Registered version only)
  187.              ------------------------------------------------
  188.  
  189. The program will automatically reset the game when the first caller of the
  190. month plays the game. The score file will be cleared and a set of Hall of Fame
  191. bulletin files will be created. The files will be called SUNHOF.ASC and
  192. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  193. directory as the KENO.EXE file. You are responsible for COPYING the files
  194. to your bulletin area and renaming to a filename of your choice.
  195.  
  196. WARNING: The HOF files are cumulative files. That means they are read in each
  197.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  198.          the record of prior months winners!!!!
  199.  
  200.  
  201.  
  202.                           BLACKOUT PERIODS
  203.                           ________________
  204.  
  205.       Use the Blackout ranges option to define up to 5 time periods during
  206.       which you DO NOT want the Door to be played. If a caller tries to access
  207.       the Door during the Blackout period, they will be shown a message that
  208.       contains ALL the Blackout periods you have defined, and to try the Door
  209.       at a later time.
  210.  
  211.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  212.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  213.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  214.  
  215.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  216.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  217.                    a Blackout range.
  218.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  219.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  220.  
  221.  
  222.                           PLAYS Per DAY/DOOR Time
  223.                           _______________________
  224.  
  225.       Plays Per Day and Door Time can be controlled several ways:
  226.  
  227.       (1) You can use the Games Per Day, singular option, in the config
  228.           file above. This option, will affect ALL callers whose Security
  229.           Level is NOT defined in any of the 10 optional Security Level/
  230.           Plays Per Day entries in the config file.
  231.  
  232.       (2) You can use the Door Time, singular option, in the config file
  233.           above. This option, will affect ALL callers whose Security
  234.           Level is NOT defined in any of the 10 optional Security Level/
  235.           Plays Per Day/Door Time entries in the config file.
  236.  
  237.       (3) You can restrict the number of games a specific Security Level
  238.           will be allowed to play per day or REWARD specific Levels with
  239.           more Plays Per Day.
  240.  
  241.           Likewise, you can restrict the Play time for a specific Security
  242.           Level or REWARD specific Levels with more Door Time.
  243.  
  244.           These options are handled by the use of the 10 config
  245.           entries (000=00/00).
  246.  
  247.           The format of each entry is as follows:
  248.  
  249.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  250.                      where =  is a constant and MUST be included
  251.                      where YY is the # of games per day (must be 2 digits)
  252.                      where / is a constant and MUST be included
  253.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  254.  
  255.           If the callers Security Level is NOT defined, his/her Plays Per
  256.           Day and Door Time will be controlled by the values in items
  257.           (1) and (2), above, respectively..
  258.  
  259.           You may define up to 10 Security Levels. All unused entries must
  260.           be defined as   00=00/00
  261.         --------------------------------------------------------------------
  262.           Example: Suppose you had 3 Security Levels defined on your BBS as
  263.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  264.           wanted to set Plays Per Day as :     Subscriber=5
  265.                                            Visiting Sysop=2
  266.                                                   CoSysop=3
  267.                                                    Friend=10
  268.  
  269.           and Door Time as follows:     Subscriber=30 minutes
  270.                                     Visiting Sysop=20 minutes
  271.                                            CoSysop=10 minutes
  272.                                             Friend=remaining call time
  273.  
  274.  
  275.           You would set the Individual "Games per Day" config entry to 1 and
  276.           the individual "Door Time" to 5 minutes (these would be the
  277.           default number of games and default Time for all Security Levels
  278.           other than 20,30 or 40... make them any number you want). Next you
  279.           would replace 4 of the Security Level entries as :  020=05/30
  280.                                                               030=02/20
  281.                                                               040=03/10
  282.                                                               090=10/0
  283.  
  284.  
  285.  
  286.                         NON-STANDARD COM SUPPORT
  287.                         ________________________
  288.  
  289.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  290.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  291.       number after the configuration filename. Let's assume your Door is
  292.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  293.       passed to your Door would be:
  294.  
  295.                             FOOBAR FOOBAR.CFG /5
  296.  
  297.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  298.       normally used with COM1. No /x parameter is needed for the standard
  299.       IRQ's.
  300.  
  301.       As an alternative, you may use an environmental variable on the command
  302.       line. To use the variable (following the example above), place a
  303.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  304.       different IRQ number for each node). The command line would now look
  305.       like this:
  306.  
  307.                           FOOBAR FOOBAR.CFG /%IRQ%
  308.  
  309.       This, in combination with the use of the environmental variables
  310.       described in the MULTI-NODE SETUP section will allow you to use one
  311.       batch file and one config file to run this door on all nodes.
  312.  
  313.  
  314.  
  315.  
  316.                            MULTI-NODE SETUP
  317.                            ________________
  318.  
  319.       All Sunrise Doors are Multi-Node capable. Each node must have the
  320.       ability to access a configuration file which will have its own system
  321.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  322.       line. There are 2 ways to accomplish this:
  323.  
  324.       (1) Create a separate configuration file for each node. The only
  325.           difference between each file would be the location of the system
  326.           file for that particular node. For example, on my system there are 2
  327.           nodes and the first line of the config files would look like this:
  328.  
  329.                         NODE1:  H:\PCB1\DOOR.SYS
  330.                         NODE2:  H:\PCB2\DOOR.SYS
  331.  
  332.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  333.  
  334.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  335.           the following PCBoard environmental variables:
  336.  
  337.                  PCBDIR    (Directory containing the System file)
  338.                  PCBDRIVE  (Drive containing the System file)
  339.  
  340.           Thus, the first line of the SINGLE configuration file, for this Door
  341.           would look like this:
  342.  
  343.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  344.  
  345.       NOTE: This option, as described, assumes that you are running PCBoard
  346.             14.5a software. The environmental variables are automatically
  347.             created by the software for each node.
  348.  
  349.             HOWEVER, if you are running other BBS software you should be able
  350.             to set the variables EXACTLY as described below, for EACH node
  351.             (more than likely in each batch file you use to bring up EACH node):
  352.  
  353.                             PCBDRIVE=C:
  354.                             ^^^^^^^^^
  355.                             PCBDIR=\NODE2
  356.                             ^^^^^^^^
  357.  
  358.             Info with a carat (^) under it, MUST be typed as is. The rest
  359.             depends on your naming conventions.
  360.  
  361.             This, in combination with the use of the optional environmental
  362.             variable described in the NON-STANDARD COM SUPPORT section, will
  363.             allow you to use one batch file and one config file to run this
  364.             door on all nodes.
  365.  
  366.  
  367.                                ADOPT-A-DOOR
  368.                                ____________
  369.  
  370.     Having been a Sysop for a number of years, I have had my share of problems
  371.     and frustrations getting financial support for my board's upkeep. A fellow
  372.     Sysop left a message on my board, not long ago, about a concept that was
  373.     being used by several boards around the country.
  374.  
  375.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  376.     would be the same as sending in a donation, only this way it is earmarked
  377.     for registering a particular door. In a way, the user feels he/she is
  378.     "getting something in return". As a Door author I have decided to build
  379.     this concept into each of my Door programs. The concept replaces the
  380.     usual message "tell the Sysop to register this Door" we find in most
  381.     doors.
  382.  
  383.     If the Door is unregisterd then a message appears on the opening screen
  384.     to that effect. After finishing or suspending a game, a message screen
  385.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  386.     caller to contact the Sysop to find out if there is any further details
  387.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  388.     time, etc to callers that ADOPT-A-DOOR.
  389.  
  390.     If the Door has been registered, either by the Sysop or other callers,
  391.     the names of those contributors will be displayed in the closing screen.
  392.  
  393.     NOTE: If you want to display the names of the callers that contributed
  394.           to registering the Door, you must create an ASCII file called
  395.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  396.           the name(s) of the contributors (one on each line, maximum of 5
  397.           entries, each a maximum of 30 characters long). This file must be
  398.           saved, in ASCII format, and placed in the Door directory.
  399.  
  400.  
  401.  
  402.                               LEGALITIES
  403.                               __________
  404.  
  405.  
  406.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  407.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  408.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  409.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  410.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  411.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  412.       OR BREACH OF ANY WARRANTY.
  413.  
  414.  
  415.  
  416.  
  417.  
  418.                              DISTRIBUTION
  419.                              ____________
  420.  
  421.    You may make this file available for downloading from your BBS or you may
  422.    upload it to any BBS of your choice, provided that you do not make any
  423.    changes to the contents of the archive (ZIP file). The archive and its
  424.    individual contents may not be used by any service that charges any money
  425.    whatsoever, without the written permission of the author.
  426.  
  427.  
  428.  
  429.  
  430.  
  431.                              REGISTRATION
  432.                              ____________
  433.  
  434.    Registration and the subsequent insertion of the registration number into
  435.    your configuation file, allows for the display of your BBS name on the
  436.    opening and closing screen as well as the reduction of a delay built into
  437.    the opening screen display along with the ability to change certain
  438.    values in the configuration file.
  439.  
  440.    To register your copy of KENO, please fill out the registration form
  441.    (REGISTER.FRM) and mail it along with the registration fee to
  442.    the name and address on the form.
  443.  
  444.    Be sure to use the proper upper/lower case when filling in your name and
  445.    BBS name, as they MUST match the way you entered them in the configuration
  446.    file.             ^^^^
  447.  
  448.    Based upon information supplied on the registration form, I will pre-
  449.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  450.    up your registration number.
  451.  
  452.  
  453.  
  454.                                  MISC
  455.                                  ____
  456.  
  457.    The latest version of KENO and other fine SUNRISE DOOR programs are
  458.    always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  459.  
  460.    Remember, should you have any problems, questions or suggestions, be sure
  461.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  462.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  463.  
  464.